docs: add Extension Comparison Guide for community extensions#1897
docs: add Extension Comparison Guide for community extensions#1897mnriem merged 5 commits intogithub:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
Adds a new documentation artifact to help users compare community extensions by category and purpose, and updates the extension publishing workflow docs to keep that guide maintained over time.
Changes:
- Add
extensions/EXTENSION-COMPARISON-GUIDE.mdwith categorized tables covering all community extensions. - Update
extensions/README.mdto reference the new guide and require updating it during extension submissions. - Update
extensions/EXTENSION-PUBLISHING-GUIDE.mdto include the comparison guide in the publishing steps/checklist andgit addcommand.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| extensions/README.md | Links to the comparison guide from the community extensions section and adds it to the submission requirements. |
| extensions/EXTENSION-PUBLISHING-GUIDE.md | Adds a dedicated step + checklist item to update the comparison guide when publishing an extension. |
| extensions/EXTENSION-COMPARISON-GUIDE.md | New quick-reference guide comparing extensions across Docs/Code/Integrations/Visibility categories. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
mnriem
left a comment
mnriem
left a comment
There was a problem hiding this comment.
Love the idea, but I rather would see an additional column in the README.md that uses a simple tag cloud (e.g. docs, code, integration, process). Otherwise we would have to keep these in sync.
|
resolved your comment. thank you! @mnriem |
There was a problem hiding this comment.
Pull request overview
Updates the community extensions documentation to help readers quickly understand what each community extension does and how it impacts a project.
Changes:
- Adds “Category” and “Effect” definitions for community extensions.
- Expands the community extensions table with new “Category” and “Effect” columns.
- Updates each listed extension row to include values for the new columns.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
mnriem
left a comment
mnriem
left a comment
There was a problem hiding this comment.
Please resolve conflicts
…ison-guide Made-with: Cursor # Conflicts: # extensions/README.md
imviancagrace
force-pushed
the
docs/extension-comparison-guide
branch
from
325d8a9 to
0fcb799
Compare
There was a problem hiding this comment.
Pull request overview
Updates the community extensions documentation in extensions/README.md to help readers compare extensions by adding a lightweight classification (“Category”) and file-modification impact (“Effect”).
Changes:
- Add “Category” and “Effect” definitions above the community extensions table.
- Expand the community extensions table from 3 columns to 5 columns (adds Category/Effect).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
imviancagrace
force-pushed
the
docs/extension-comparison-guide
branch
from
d4f20a0 to
0fcb799
Compare
There was a problem hiding this comment.
Pull request overview
Updates the community extensions documentation in extensions/README.md to add a lightweight comparison guide (Category/Effect) for each listed community extension.
Changes:
- Adds definitions for new
CategoryandEffectfields to help interpret the community extensions list. - Updates the community extensions table entries to include Category/Effect information.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@mnriem conflicts and copilot review resolved |
There was a problem hiding this comment.
Pull request overview
Updates the community extensions documentation to make the extensions/README.md community table more informative and to align contributor guidance in the publishing guide.
Changes:
- Adds
CategoryandEffectcolumns to the community extensions table inextensions/README.md, plus brief definitions for those fields. - Updates
extensions/EXTENSION-PUBLISHING-GUIDE.mdto reflect the new table row format and document the allowed Category/Effect values.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| extensions/README.md | Expands the community extensions table with Category/Effect and adds a short legend explaining the new fields. |
| extensions/EXTENSION-PUBLISHING-GUIDE.md | Updates submission instructions/snippet to include the new Category/Effect fields and defines the accepted values. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@imviancagrace Almost there. You just need to resolve the conflicts! |
…ison-guide Made-with: Cursor # Conflicts: # extensions/README.md
imviancagrace
force-pushed
the
docs/extension-comparison-guide
branch
from
eb39c38 to
d4c4b1a
Compare
|
these conflicts lol! thanks for all your help @mnriem |
There was a problem hiding this comment.
Pull request overview
This PR updates the community extensions documentation to better compare extensions by adding classification metadata to the table in extensions/README.md.
Changes:
- Adds
CategoryandEffectcolumns to the community extensions table. - Introduces short definitions for the allowed Category and Effect values above the table.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Thank you! Lots of folks doing stuff so these things keep it all entertaining |
The README table now has Category and Effect columns (added in github#1897), but the publishing guide template still showed the old 3-column format. Update to match so extension authors know to include both fields. Made-with: Cursor
|
@mnriem i just realized for some reason, changes to the EXTENSION-PUBLISHING-GUIDE.md to align with the new table in the README.md were reverted. Let me know if you'd want me to create a PR for this or if you'd rather include it in your upcoming PRs. |
|
A new PR is fine. Again thank you! |
Description
Updates the
README.md. Added two new columns, Category and Effect, in the community extension table.Testing
N/A — documentation-only change. Verified all markdown links and table formatting render correctly.
AI Disclosure
Used Cursor to analyze the 19 community extensions in
catalog.community.jsonfor overlapping functionality, draft the comparison guide, and iterate on the format. All content was reviewed and directed by the author.